-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix broken links #548
Fix broken links #548
Conversation
Thanks for fixing these links ! |
@LorenzoMarnat Iam going to solve #516 on your branch.
|
I put the FAILURE_THRESHOLD at 0 to detect every dead link |
This is great. In addition to this work however, we might want to consider a flaw with remark validate links... Bascially, Remark doesn't validate absolute links (which are accepted by github in markdown documents). It only checks relative links or URLs. This means that we might still have some broken links. This was worked around in the private repository here by using a export BASE_URI='https://github.com/VCityTeam/VCity/blob/master'
files=$(find . -name '*.md')
for f in $files
do
grep -E '\[{1}.*\]{1}\({1}/{1}.*\){1}' "$f" | sed -i "s|](/|]($BASE_URI/|g" "$f"
done
remark -u validate-links . I think it would be a good idea to do the same in UD-Viz. Maybe in a different PR? Any thoughts? |
Since this PR is called "Fix broken links" imo we should let this open. I'm not sure to understand why there could be absolute link in .md, could you give an example of link that remark doesnt detect ? |
Actually absolute link should be consider as a bad practice since the root of the path will depend of the context in which it's interpreted (like vscode workspaces or github organization). Iam going to add in the script validate-links a code to detect absolute links and throw an error if one is found.
|
c310c4d
to
ac84c28
Compare
docs/static/Devel/Configuring-the-Document-model-of-an-UDV-deployment.md
Show resolved
Hide resolved
8cd3e18
to
2c892cd
Compare
The goal of this PR is to fix the links in UD-Viz documentation
remark -u validate-links .
still returns 30 warnings (instead of 74)